Resource Documents

A Resource Document is a document file, like an equipment manual, that you upload to a specific FormSpaceClosed FormSpaces are where forms are stored and organized in the TrueContext Web Portal. A TrueContext Team may have multiple FormSpaces, depending on their needs. Admins can set FormSpace permissions to control which users have access to the forms in that FormSpace. in the Web Portal. You can reference a Resource Document in any form in that FormSpaceClosed FormSpaces are where forms are stored and organized in the TrueContext Web Portal. A TrueContext Team may have multiple FormSpaces, depending on their needs. Admins can set FormSpace permissions to control which users have access to the forms in that FormSpace. that has a Document Editor question. When you update a Resource Document, any forms that reference the document update when a field technician reconciles their device.

You can also add a Resource Document to the Resource Library for field technicians to access anytime.

This topic describes when and why you’d use Resource Documents in forms and in the Resource Library. It also describes how to create, edit, and delete a Resource Document in the Web Portal.

Available on the Enterprise tier only:

Essentials
Advanced
Enterprise

Contents

Resource Documents in forms

To use Resource Documents in forms, you set up Document Editor questions that allow field technicians to annotate PDF documents.

A Document Editor question. The user has added the Updated Excavator Inspection Manual as a Resource Document to annotate.

You can choose any Resource Document that’s in the same FormSpace, and different forms can use a single Resource Document.

Resource Documents in the Resource Library

The Resource Library enables you to build a digital, multilingual, and searchable knowledge base that contains your organization’s essential content. Available to your mobile users in the TrueContext Mobile App, the Resource Library simplifies the distribution, discovery, and use of critical information—such as manuals and schematics—to support your field technicians in their work.

When you create a Resource Document, you can make the resource visible in the Resource Library. The Resource Library is a tab on the Mobile App home screen. This makes it possible for field technicians to open a Resource Document outside of a form.

A field technician must have Can Submit or Can Test permissions in the FormSpace to open and use the Resource Library. If a technician has these permissions in multiple FormSpaces, the Resource Library on their device can display resources from different FormSpaces.

The Resource Library in list view. The list includes an AC Schematic, an Air Conditioning Unit Manual, a Furnace Maintenance Guide, an Industrial Water Heater Repair Manual, and an Excavator Inspection Manual, and an HVAC system diagram in French. All resources include a short description, and some are available in other languages.

Info:Our documentation on the Resource Library describes this feature in more detail.

Resource Document file types and sizes

The following table describes file types you can add as Resource Documents and where you can use them.

File type Can be used in forms? Can be used in the Resource Library? Max size
PDF Yes Yes* 5 MB
Word No
Excel

*In the Resource Library, all documents open in a PDF viewer.

When to use a Resource Document

Use a Resource Document as part of a Document Editor question to provide field users with a PDF file to annotate.

Because a Resource Document is a shared resource within the FormSpace, it's easy to keep all your forms up to date with the latest version. Simply edit your Resource Document to make any changes, such as uploading a new PDF file. The document updates after a reconcile—there's no need to manually update any of your forms.

Create a Resource Document

  1. Go to Forms & Integrations > Resources.

  2. Select Create Resource, and then select Resource Document.

  3. Select Choose File, and then select a document from your local files or cloud service.

    Tip: The following table describes file types you can add as Resource Documents and where you can use them.
    File typeCan be used in forms?Can be used in the Resource Library?Max size
    PDFYesYes*5 MB
    WordNo
    Excel

    *In the Resource Library, all documents open in a PDF viewer.

    Result: Sections display to enter resource details, add tags, and set up additional language resources (Multi-Language add-on only).

  4. Enter a name and description. A description explains how a field technician should use the resource. It also improves search results in the Resource Library on the Mobile App.

    The Create Resource Document page in the TrueContext Web Portal. A user is adding an Elevator Inspection Manual as a Resource Document.

    Do you want to add an AI generated summary to your description?

    • If yes, select View AI generated summary or select the arrow next to Suggested Summary. Select Add to Description. Edit the description as necessary.

      An AI generated summary for an excavation manual. The AI has generated a bulleted list that summarizes the document. A user can select Add to Description to use the summary in their description.

    • If no, enter a description manually.

  5. Do you want to make the Resource Document available in the Resource Library?

    • If yes, select Visible in Resource Library.

      Result: Once you save the resource, a field technician can access the resource in the Resource Library as soon as they reconcile their device.

      Note:An Admin user must enable the Resource Library tab so that field technicians can see the Resource Library on their devices.

    • If no, go to step 6.

  6. (Optional) Add resource tags. You can use tags to filter the resources list. Tags also help field technicians filter the Resource Library to find what they need. To add a resource tag, select Add Tags to this resource, and then type to select or create a tag.

    The tags section on the Create Resource Image page in the TrueContext Web Portal. Add Tags to this resource is selected, and the user has applied two tags: diagram and hvac.

    Info:The section Resource Documents: Apply resource tags describes the benefits of tagging resources in more detail.

  7. (Optional) Link translated resources. This option is only available if your company has the Multi-Language add-on for the Enterprise tier.

    The Additional Language Resources section in a Create Resource page on the TrueContext Web Portal. The parent resource's languge is English. Linked resources have been added in Spanish, German, and French.

    Info:The section Resource Documents: Set up multiple languages describes this process in more detail.

  8. Select Create or Update.

    Result: The Resource Document is available for Form Designers to reference in forms.

  9. Do you want to create another Resource Document?

    • If yes, select Create Resource Document. This will be a new resource, not a linked resource.

      An Air Conditioning Unit Manual added as a resource document. Buttons allow the user to edit the resource document or create a new resource document.

    • If no, you have completed the procedure.

Apply resource tags

Resource tags in the Web Portal

Tags help you filter the list of resources by relevant criteria. Select one or more tags from the Filter section on the Resources page to find resources that have those tags.

The Filter section on the Resources page. The user has selected the hvac and inspection tags.

Resource tags in the Resource Library

Tags also help organize resources in the Resource Library. A field technician can use tags to filter the Resource Library on their device and quickly find relevant documents and images.

The filters menu in the Resource Library on the Mobile App. Language filters available are German, English, Spanish, and French. Tags available include construction, diagram, excavator, hvac, and inspection. The hvac tag is selected.

Tagging guidelines

You might tag a Resource Document by:

  • Equipment types, like motors or air conditioning units.

  • Equipment brands or makes.

  • Resource types, like schematics or manuals.

Info:Tags applied to a Resource Document also apply to any linked translations. The section Resource Documents: Set up multiple languages describes translated resources in more detail.

Steps to apply resource tags

To apply tags to a Resource Document:

  1. Select Add Tags to this resource.

    Result: The Tags section expands to display a field to enter tags.

  2. Enter a tag. As you type, existing tags display as suggestions. Select an existing tag, or press Enter or Return to create a new tag. Repeat this process for each tag you want to add.

    The tags section on the Create Resource Image page in the TrueContext Web Portal. Add Tags to this resource is selected, and the user has applied two tags: diagram and hvac.

Note:Resource tags are different from form tags. The topic Set Up Form Properties: Form Information describes how to add tags to a form.

Set up multiple languages

Available as an add-on to the Enterprise tier:

Essentials
Advanced
Enterprise +Add-on

Translated resources in forms

If your company has the Multi-Language add-on, you can link translated files to a Resource Document. When a field technician opens a Multi-Language form and selects a language, the Resource Document displays the translated file.

You link Resource Documents in a primary-secondary or parent-child relationship. A resource in one language acts as the primary to any translated resources. If a field technician’s preferred language is unavailable, the primary resource language displays by default.

Translated resources in the Resource Library

The Resource Library also supports translated resources. When a field technician opens a Resource Document in the Resource Library, they can easily switch between languages. If a field technician has a preferred form language set, Resource Documents display in this language by default. A field technician can also filter the library by language.

The Additional Language Resources section in a Create Resource page on the TrueContext Web Portal. The primary resource's languge is English. Linked resources have been added in Spanish, German, and French.

Steps to set up translated resources

Info:The Resource Document you are currently setting up is the primary resource by default. Translated resources inherit resource tags from their primary.

Once your translated resources are set up, you can delete the primary resource and select a new primary. The section Delete a Resource Document describes this process in more detail.

  1. Select Set up multiple languages.

    Result: The Additional Language Resources section expands to display the Language menu and Linked Resources table.

  2. Select the language of the primary Resource Document you are setting up.

    A resource document with Set up multiple languages selected. This resource is in English.

  3. Add or link to at least one translated resource.

    • To add a new resource, select Add New Resource. Enter a Name and Description, and then select Choose File. Select a file, select a Language, and then select Add.

      The Add new Resource window. The user is adding a new resource in German.

    • To select an existing resource, select Link Existing Resource. Select one or more resources to link to the new resource, select a language for each translated resource, and then select Link.

      Note:You can only link resources that are not already linked to other resources.

      The Link Existing Resource window. A user has selected a resource to link and set the resource language to Spanish.

    Result: The primary resource is linked to versions in different languages.

    Note:A translated resource can be in a different format than its primary. For example, if the primary resource is a PDF, you can link Word and Excel documents. However, you cannot use Word or Excel documents in Document Editor questions in forms. If a primary resource links to one of these file types, you cannot use the primary resource in a form.

  4. Select Create or Update.

Bulk Create Resources

Rather than adding Resource Documents one by one, you can bulk create up to 10 resources at once. A bulk batch can include both Resource Images and Resource Documents.

Tip:When you bulk create resources, the system adds each resource individually. You can’t bulk create a group of translated resources that are already linked. However, you can bulk create the same resource in multiple languages, and then link the files after. The section Set up multiple languages describes how to link existing resources in more detail.

  1. Go to Forms & Integrations > Resources > Bulk Create Resources.

    The Bulk Create Resources page.

  2. Select Choose Files.

    Result: A window opens to select documents and images from your local files.

  3. Select up to 10 files, and then select Create.

    Result: A summary of the newly created resources displays. Select a resource to preview or edit it. If any files fail to upload, a second table lists the errors.

    A page of results after creating resources in bulk. The user has created four documents and two images. Also, two documents and one image could not be uploaded because the file names are already in use.

    Note:A file will fail to upload if:

    • The file is too big. Resource Documents have a maximum file size of 5 MB. Resource Images have a maximum file size of 2 MB.
    • The file type is not supported. A Resource Document must be a PDF, Word, or Excel file. A Resource Image must be in JPEG, JPG, or PNG format.
    • The file name is already in use.

  4. Do you want to bulk create more resources?

    • If yes, select Bulk Create Resources. Return to step 2.

    • If no, you have completed the procedure.

Filter Resource Documents

By default, the resources table lists resources alphabetically. Use the Search bar to search for matching text in resource names.

You can also filter the list of resources according to a number of criteria to quickly find what you need.

The menu of filters on the Resources page. A user has applied filters to find Documents in Spanish that are not in use in any forms and are linked to other resources.

You can filter the list by:

  • Typeselect Document to filter for Resource Documents.

  • Language—select a language, or select Unspecified to find Resource Documents with no language assigned.

  • In Use—find Resource Documents that are used in questions in forms. For example, some forms use Document Editor questions that reference Resource Documents. You can also filter for resources that aren’t used in any forms.

  • Group—find Resource Documents that are linked to translated resources in language groups. You can also search for Ungrouped resources.

  • Tags—select one or more tags to find Resource Documents with those tags. If you select multiple tags, you can find resources with All or Any of the tags you selected.

  • Visible in Device Resource Library—find Resource Documents that are available to field technicians in the Resource Library on the Mobile App.

Select filters as necessary, and then select Apply.

Tip:Filtering matches all criteria. The more filters you apply, the fewer results you will receive. You can also combine filters with search terms to narrow the list further.

Edit a Resource Document

Edit a Resource Document to change the name and description or to select a different file. This is useful if you want to update a Resource Document without creating a new resource.

If the Resource Document is a primary resource, you can also edit resource tags and add or remove translations.

Note:Any new files you add cannot exceed 5 MB.

You can add Excel and Word documents to the Resource Library, but you can’t use them in a form.

You can edit a Resource Document in one of the following ways:

  • Go to Forms & Integrations > Resources. Hover over a Resource Document, and then select Edit.

    The Resources list in the TrueContext Web Portal. The cursor hovers over a resource to reveal the Edit and Delete options.

  • Go to Forms & Integrations > Resources. Select a Resource Document to open it. Then, select Edit Resource Document.

    A resource document for an Air Conditioning Instruction Manual. A callout points to the option to Edit Resource Document.

Tip:After you save, all forms that reference the Resource Document automatically update with the new file when a user reconciles their device.

Delete a Resource Document

Note:Deleting a Resource Document is permanent and can’t be undone.

You can't delete a resource if any forms use it. Open a resource and check the Referencing Forms section to find a list of forms that use the resource.

  1. Go to Forms & Integrations > Resources.

  2. Select a Resource Document to delete. You can do this in two ways:

    • Hover over a Resource Document, and then select Delete

      The Resources page in the TrueContext Web Portal. The cursor hovers over a resource to reveal the Edit and Delete options.

    • Select a Resource Document to open it. Then, hover over the arrow and select Delete.

  3. Is the Resource Document a primary resource?

    • If yes, and you want to delete the resource and all linked resources:

      1. Select Delete this resource and all linked resources, and then select Proceed.

    • If yes, and you want to select a new primary:

      1. Select Delete this resource and select an alternative....

      2. Select a new primary.

        The modal to delete a parent resource. You can delete the resource and all linked resources or select a linked resource to be the new parent.

      3. Select Proceed.

    • If no, select Permanently Delete Resource Document.